GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the properties before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of properties.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "PropertyId": "f4d77628-daaa-4ec0-b764-7427a8eeda5e", "Asset": { "AssetId": "a8a79541-7634-4957-b465-0e4aa952e3ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7ebaa32a-8e9e-432b-bb06-898b13914426", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85b463c0-3654-4c4b-b208-5faecd01f225", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "cb4cc39f-562e-4553-b9e1-2225a281cc46", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "MeasurementValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "SourceSystemId": "sample string 3", "CompanyId": "756d00e6-83c0-494c-9296-b32368c810ca", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "MeasurementValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b6685781-3e7b-43ba-90a1-42c83d3128ed", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "1251219d-19df-47da-95ca-4a979d03fe2f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7ebaa32a-8e9e-432b-bb06-898b13914426", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85b463c0-3654-4c4b-b208-5faecd01f225", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "c7032b78-73bd-47c9-9331-7bbc1e39e1ab", "Name": "sample string 1" }, "Unit": { "UnitId": "4c1f7fef-904a-482d-a726-dc539e8837c6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d1c59e48-f2a2-4d4d-a540-2bfce6f2a55c", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "423f7358-0903-438b-bc05-24435d1101f4", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4f7b7648-7ff6-4158-95c6-161a1aef5181", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "f4d77628-daaa-4ec0-b764-7427a8eeda5e", "Asset": { "AssetId": "a8a79541-7634-4957-b465-0e4aa952e3ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7ebaa32a-8e9e-432b-bb06-898b13914426", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85b463c0-3654-4c4b-b208-5faecd01f225", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "cb4cc39f-562e-4553-b9e1-2225a281cc46", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "MeasurementValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "SourceSystemId": "sample string 3", "CompanyId": "756d00e6-83c0-494c-9296-b32368c810ca", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "MeasurementValueNeededDate": "2024-05-04T09:50:15.9455421-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b6685781-3e7b-43ba-90a1-42c83d3128ed", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "1251219d-19df-47da-95ca-4a979d03fe2f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7ebaa32a-8e9e-432b-bb06-898b13914426", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "85b463c0-3654-4c4b-b208-5faecd01f225", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "c7032b78-73bd-47c9-9331-7bbc1e39e1ab", "Name": "sample string 1" }, "Unit": { "UnitId": "4c1f7fef-904a-482d-a726-dc539e8837c6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d1c59e48-f2a2-4d4d-a540-2bfce6f2a55c", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "423f7358-0903-438b-bc05-24435d1101f4", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4f7b7648-7ff6-4158-95c6-161a1aef5181", "CreateDate": "2024-05-04T09:50:15.9455421-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T09:50:15.9455421-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }